package com.tiny.tinyweb.core.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 用来配置实体的注解类，包括实体类对应的表名、主键列表和乐观排他字段列表。 该注解仅用于实体类。
 *
 * @author wxiaobin
 * @version 1.0
 * @since 1.0
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface TableInfo {
    /**
     * 配置实体类对应的表名。
     * @return 实体类对应的表名
     */
    public String name() default "";

    /**
     * 配置实体类对应的主键列表。
     * @return 实体类对应的主键列表
     */
    public String[] primaryKeys() default {};

    /**
     * 配置用于乐观排他的字段列表。
     * @return 用于乐观排他的字段列表
     */
    public String[] lockColumns() default {};
}
